home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / umich / telecomm / stkeep.lzh / BBS / DOCS / BBSFILES.DOC < prev   
Encoding:
Text File  |  1993-03-29  |  8.2 KB  |  277 lines
  1. ST-Keep System Files Format Reference
  2. Copyright 1993 by Andrew P. Studer
  3.  
  4. Updated:  26Nov92
  5.  
  6. * WARNING *  This file contains information critical to the security
  7.              of your BBS, do not hand it out freely.
  8.  
  9. NOTE:  Use this information with extreme caution, I will not be
  10.        responsible for loss of data due to misuse or inaccuracy of this
  11.        document.
  12.  
  13.   //////////////////// 
  14.  /// STK_INFA.SYS /// This file contains various defaults for the BBS.
  15. ////////////////////
  16.  
  17. Key:   * = DO NOT MODIFY THIS LINE, SYSTEM CRITICAL INFORMATION
  18.  
  19.        $ = CHANGE ONLY IF YOU MOVE THE CORRESPONDING FILES
  20.  
  21. Line #  Description
  22. ------  -----------
  23.  
  24.   1     Maximum baud rate code:
  25.  
  26.            0 = 19200    1 =  9600    2 =  4800
  27.            4 =  2400    7 =  1200    9 =   300
  28.  
  29.          192 = port locked at 19200
  30.    
  31.   2  *  Maximum userlog size
  32.  
  33.   3  *  Maximum number of rooms
  34.  
  35.   4  *  System flags - bit 0 = real names only, no handles
  36.                            1 = append new users if userlog full
  37.                            2 = allow deletion of msgs in room 4 and
  38.                                the system activity room?
  39.                            3 = allow users to create rooms
  40.                            4 = install new user accounts
  41.                            5 = time bank enabled
  42.  
  43.   5  *  System flags - bit 0 = secure mode
  44.                            1 = modem off-hook on local logon
  45.                            2 = verbose file transfers
  46.                            3 = unused
  47.                            4 = unused
  48.                            5 = status line @ logon
  49.                            6 = chat mode disabled?
  50.                            7 = bbs disabled?
  51.  
  52.   6     Number of calls since system initialization
  53.  
  54.   7     Chat exec path/filename
  55.  
  56.   8  *  Maximum number of messages per room
  57.  
  58.   9     System Password
  59.  
  60.  10  $  System files pathname (BBS.PRG & *.SYS files)
  61.  
  62.  11  $  Blurb files pathname (*.BLB)
  63.  
  64.  12  $  Help files pathname (*.HLP)
  65.  
  66.  13  $  Bulletin files (*.BU?)
  67.  
  68.  14  $  Vote files (*.VOT, *.ANS)
  69.  
  70.  15  $  Drive/path/filename of file transfer executable pathname (XYZ.TTP)
  71.  
  72.  16  $  Pathname for temporary files
  73.  
  74.  17     Post-logon exec door number
  75.  
  76.  18     Number of records in STK_CALL.SYS
  77.  
  78.  19     Door to run if key in line 28 is pressed, 0 for door menu
  79.  
  80.  20  *  BBS Name (do not change this if you are registered)
  81.  
  82.  21     Modem initialization string:
  83.  
  84.            Requires - ATS0=1 to answer on the first ring
  85.                       ATS2=255 to disable remote control of the modem
  86.                       DCD should not be set to always on
  87.  
  88.  22     System-wide miscellaneous comment field
  89.  
  90.  23     Default time limit, in minutes, for new users, 255 = unlimited
  91.  
  92.  24     Default download ratio for new users, 255 = unlimited
  93.  
  94.  25     SysOp's first name
  95.  
  96.  26     SysOp's last name
  97.  
  98.  27     Logoff Exec door number
  99.  
  100.  28     ASCII code for hot-key to auto-door (line 19)
  101.  
  102.  29     Room number where ST-Keep will save download messages, 0=room 3 
  103.  
  104.  30  $  Drive/path/filename of STZIP.PRG for verbose listing
  105.  
  106.  31  $  Drive/path/filename of LHARC.TTP for verbose listing
  107.  
  108.  32     Password to bypass disabled bbs
  109.  
  110.  33     Minimum baud rate to call system
  111.  
  112.  34     Minimum baud rate for file transfers
  113.  
  114.  35     Maximum minutes on-line per day
  115.  
  116.  36  $  Message base path
  117.  
  118.  37     Time-out in minutes
  119.  
  120.  38     Use file selector (0=off, 1=on)
  121.  
  122.  39     New user defaults A (use BBS_CNFG.PRG to modify)
  123.  
  124.  40     New user defaults B ("")
  125.  
  126.  41     New user screen length (0-25)
  127.  
  128.  42     New user emulation 0-5
  129.  
  130.  43     New user tabs 0-20
  131.  
  132.  44     New user file xfer protocol (0-4)
  133.  
  134.  45  $  Terminal program path/filename
  135.  
  136.  46     Serial number (obtain from Andrew Studer)
  137.  
  138.  
  139.   ////////////////////
  140.  /// STK_INFB.SYS /// Contains message base information
  141. ////////////////////
  142.  
  143. * WARNING *  Never edit this file or you will destroy the integrity
  144.              of your message base.
  145.  
  146. Line #  Description
  147. ------  -----------
  148.  
  149.   1     Total number of bytes written to the message file
  150.   2     Oldest message number in the message file
  151.   3     Number of the next message to be written to the message file
  152.   4     File offset location to write the next message
  153.  
  154.   ////////////////////
  155.  /// STK_INFC.SYS /// Contains ST-Keep color palette data
  156. ////////////////////
  157.  
  158. 32 bytes of information, 2 bytes for each color register (0-15) used 
  159. by the ST's setpalette() routine (XBIOS #6).
  160.  
  161.   ////////////////////
  162.  /// STK_HDRS.SYS /// Room header information
  163. ////////////////////
  164.  
  165. Each line in this file contains the room header for the relative room 
  166. number.  Line 1 contains the header for the room 1, line 2 for room 2 (Mail),
  167. etc.  [R][I] shows the room number you are in.  If used, this file 
  168. must contain a number of lines equal to the maximum number of rooms 
  169. in your system with blank lines for rooms without headers.
  170.  
  171.   ///////////////////
  172.  /// STK_ARC.SYS /// Room archive filenames
  173. ///////////////////
  174.  
  175. Each line in this file contains the pathname/filename of each room 
  176. that is being archived.  If used, this file must contain a number of 
  177. lines equal to the maximum number of rooms in your system with blank 
  178. lines for rooms that aren't being archived.
  179.  
  180.   ///////////////////
  181.  /// STK_GRP.SYS /// Group names
  182. ///////////////////
  183.  
  184. 15 lines, each containing the name of the relative group.  If the 
  185. group is unused the line must be blank. 
  186.  
  187.   ////////////////////
  188.  /// STK_MODR.SYS /// Room Moderator names
  189. ////////////////////
  190.  
  191. A number of lines equal to your total maximum rooms, each line contains the
  192. username of the Moderator for the valid room.  It is blank if there is no
  193. moderator.
  194.  
  195.   ////////////////////
  196.  /// STK_ROOM.SYS /// Room data
  197. ////////////////////
  198.  
  199. This block of data is repeated a number of times equal to the maximum 
  200. number of rooms.
  201.  
  202. Offset    Description
  203. --------  -----------
  204.  1 - 30   Name, space padded to the right
  205. 31 - 60   Directory pathname, space padded to the right
  206. 61        Generation number, 0=inactive, 1-255 gen
  207. 62        First flag
  208. 63        Second flag
  209. 64        Group number, if non-zero this room is only available to
  210.           users of this group
  211. 65        Floor number that it exists on
  212.  
  213. The following two fields are repeated for each message in the room.  If
  214. your system has 50 messages per room, this group of bytes will be repeated
  215. 50 times before the next room information structure begins.
  216.  
  217. 66 - 69   Message number 
  218. 70 - 73   Message location
  219. ~~ - ~~   Repeated for each message in this room
  220.  
  221.      ~~   This block repeated for each room
  222.  
  223.   ////////////////////
  224.  /// STK_USER.SYS /// User account information
  225. ////////////////////
  226.  
  227. This block of data is repeated a number of times equal to the maximum 
  228. number of user accounts.
  229.  
  230. Offset    Description
  231. --------  -----------
  232.  1 - 20   Password
  233. 21 - 50   Username
  234. 51 - 70   Personal Comment field
  235. 71 - 83   Phone Number
  236. 84        Access Level
  237. 85 - 86   Number of calls (hi/low)
  238. 87 - 88   Last call date (hi/low MS/DOS format)
  239. 89 - 90   Last call time (hi/low MS/DOS format)
  240. 91 - 100  Users birth date (mm/dd/yyyy format)
  241. 101       Unused
  242. 102       Minutes per day
  243. 103       Minutes left today
  244. 104       Screen width
  245. 105       Userflag A
  246. 106       Userflag B
  247. 107 - 117 Unused
  248. 118 - 199 Download count (hi/low)
  249. 120 - 121 Upload count (hi/low)
  250. 122       Upload protocol
  251. 123 - 124 Number of messages written (hi/low)
  252. 125       Download ratio
  253. 126 - 127 Unused
  254. 128       Graphic emulation (0=ascii, 1=vt52, 2=ansi)
  255. 129 - 130 Group bits (0-15)
  256. 131       Tab spaces (0+)
  257. 132 - 134 Unused
  258. 135 - 164 Real Name
  259. 165 - 184 City, State
  260.  
  261. The following two fields are repeated a number of times equal to the
  262. maximum number of messages allowed in each room.  These are user mail
  263. pointers.
  264.  
  265. 185 - 188 Message number
  266. 189 - 192 Message location
  267. ~~~ - ~~~ Repeated for each message in the mail room, even empty messages
  268.   
  269. The following two fields are repeated once for every room on the BBS.  This
  270. includes unused room slots.
  271.  
  272. 193       Generation number for this room
  273. 194 - 197 Last message read in this room
  274.  
  275.  "     "  Next user structure
  276.  
  277.